Modify upgrade campaign settings and target selection criteria

Request

Requires upgrade-manager::modify permission.

Security

JWTAuthorizer

Path

upgradeIDstringrequired

Unique ID of upgrade

Bodyapplication/jsonrequired

Upgrade Input

excludeTagsobject

Exclude devices with these tags

includeTagsobject

Include devices with these tags

manualFailoverboolean

Whether to require approval to failover clusters

namestringrequired

Upgrade name

offlineTimeoutnumber

Minutes to wait before failing (timing out) a workflow for a node in the offline state

upgradeTimeoutnumber

Minutes to wait before failing (timing out) a workflow

curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/upgrade-manager/api/v1/upgrades/{upgradeID}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "excludeTags": {
      "property1": "string",
      "property2": "string"
    },
    "includeTags": {
      "property1": "string",
      "property2": "string"
    },
    "manualFailover": true,
    "name": "string",
    "offlineTimeout": 0,
    "upgradeTimeout": 0
  }'

Responses

OK

Bodyapplication/json

clusterUpgradesArray of objects(ClusterUpgrade)

completedAtstring

Upgrade completion time

dryRunboolean

Whether this was a dry-run

excludeTagsobject

Exclude devices with these tags

failoverApprovedboolean

True once a user has approved cluster failovers

includeTagsobject

Include devices with these tags

manualFailoverboolean

Whether to require approval to failover clusters

namestring

Name of upgrade

Example:"Sep27"

nodeUpgradesArray of objects(NodeUpgrade)

offlineTimeoutnumber

Minutes to wait before failing (timing out) a workflow for a node in the offline state

startedAtstring

Upgrade start time

statusstring

Status of upgrade

Enum:"active""planning""complete"

uidstring

Unique ID of upgrade

Example:"2DqxLdknjWxEkGt474d2Cstsa1O"

upgradeTimeoutnumber

Minutes to wait before failing (timing out) a workflow

Response

{
  "clusterUpgrades": [
    { … }
  ],
  "completedAt": "string",
  "dryRun": true,
  "excludeTags": {
    "property1": "string",
    "property2": "string"
  },
  "failoverApproved": true,
  "includeTags": {
    "property1": "string",
    "property2": "string"
  },
  "manualFailover": true,
  "name": "Sep27",
  "nodeUpgrades": [
    { … }
  ],
  "offlineTimeout": 0,
  "startedAt": "string",
  "status": "active",
  "uid": "2DqxLdknjWxEkGt474d2Cstsa1O",
  "upgradeTimeout": 0
}